/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * This file is part of retabel.
 *
 * Copyright (c) 2011 by individual contributors as indicated by the
 * @author tags. See the copyright.txt file in the distribution
 * for a full listing of individual contributors.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */

package org.retabel.service.render.exportable;

import org.retabel.persistence.entity.document.SectionConfiguration;
import org.retabel.persistence.entity.report.RenderingEngineEnum;

/**
 * Parameter class holding the information about section configurations and rendered content.
 * <p/>
 * <h3>Extra-Info</h3>
 * Created: 21:41 26.09.11
 *
 * @author Burt Parkers
 * @version 1.0
 */
public abstract class ExportableDocumentPart<T> {

    /** The section configuration. */
    private final SectionConfiguration sectionConfiguration;

    /**
     * Creates a parameter object.
     *
     * @param sectionConfiguration the section configuration.
     */
    public ExportableDocumentPart(SectionConfiguration sectionConfiguration) {
        this.sectionConfiguration = sectionConfiguration;
    }

    /**
     * Gets the renderedContent.
     *
     * @return The renderedContent value.
     * @throws Exception if an exception occurs.
     */
    public abstract T getRenderedContent() throws Exception;

    /**
     * Gets the sectionConfiguration.
     *
     * @return The sectionConfiguration value.
     */
    public SectionConfiguration getSectionConfiguration() {
        return sectionConfiguration;
    }

    /**
     * Convenience method for accessing the section configuration associated rendering engine
     *
     * @return The rendering engine associated to the secion configurations report design
     */
    public RenderingEngineEnum getRenderingEngine() {
        return sectionConfiguration.getReportDesign().getReportDesignPackage().getRenderingEngine();
    }
}
